home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / chkmail.zip / CHKMAIL.DOC next >
Text File  |  1992-05-19  |  12KB  |  200 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                   CheckMail for WildCat 3.0 - Version 1.03                  ║
  3. ║              Copyright (c) 1992, Computer Discount Center, Ltd.             ║
  4. ╚═════════════════════════════════════════════════════════════════════════════╝
  5.  
  6. This program was created out of a need to avoid running the SCAN option of
  7. WildMail if no messages were entered by the BBS user.  The command format is
  8. as follows:
  9.  
  10. CHKMAIL [node] [/ANY]
  11.  
  12. To use this utility, simply put CHKMAIL.EXE into the batch file that runs your
  13. bulletin board.  Have the batch file run CHKMAIL.EXE immediately after the
  14. WildCat program exits.  If the [node] parameter is included, CheckMail will
  15. check to see if the last user entered mail in the specified node, and/or if
  16. the user called the TomCat Mail Door.  The main reason to run the utility is
  17. to greatly improve the speed of your system by only running the WM SCAN option
  18. if a user entered mail into the message bases.  The "/ANY" switch can be used
  19. to indicate whether only netmail and echomail conferences should be checked,
  20. or whether "any" conferences including local BBS conferences should be checked.
  21.  
  22. The program sets the DOS errorlevel to indicate whether you should run the
  23. WM SCAN program as follows:
  24.  
  25.          Errorlevel 1 - Messages were entered - run WM SCAN
  26.          Errorlevel 0 - No messages entered   - no need to run WM SCAN
  27.  
  28.  
  29. A sample batch file snippet follows:
  30.  
  31.  
  32.        .
  33.        .
  34.        .
  35.        WILDCAT /B %1 %2                     <-- Runs WildCat BBS
  36.        CHKMAIL                              <-- Sets errorlevel if msg entered
  37.        IF ERRORLEVEL 1 GOTO SCANMAIL        <-- If mail entered, run WM SCAN
  38.        IF ERRORLEVEL 0 GOTO BYPASS          <-- If no mail entered, don't scan
  39.        :SCANMAIL
  40.        WM SCAN                              <-- Scan using WildMail
  41.        :BYPASS
  42.        GOTO FRONTDOOR                       <-- Return to Mailer
  43.        .
  44.        .
  45.        .
  46.  
  47. The CheckMail program works by examining the activity log to see whether any
  48. messages were entered in the last session.  Be sure to put CHKMAIL.EXE in the
  49. same subdirectory as your ACTIVITY.xxx file.  If you only want to watch for
  50. messages in echo mail and netmail, put a copy of your AREAS.BBS and WM.CFG
  51. files there too.
  52.  
  53. If you want to use CheckMail on other nodes, put the node number immediately
  54. following the CHKMAIL command.  Example for node 2:
  55.  
  56. CHKMAIL 2
  57.  
  58. If the activity log cannot be found in the current subdirectory, the program
  59. exits with the error message:
  60.  
  61.  "The activity log ACTIVITY.xxx could not be found."
  62.  
  63.  
  64.  
  65. As the program runs, a number of status messages may appear on the screen:
  66.  
  67.  
  68.  "No new mail added to conferences ..."  -  This means that the program did
  69.                                             not find where the last user
  70.                                             entered any messages.  Program
  71.                                             will exit with ERRORLEVEL = 0.
  72.  
  73.  "Mail added to conference(s) ..."       -  This means that the program
  74.                                             determined that the last user
  75.                                             did enter a message into at least
  76.                                             one conference.  This message
  77.                                             appears if the /ANY switch is used
  78.                                             and a message is entered into any
  79.                                             conference.  Program will exit with
  80.                                             ERRORLEVEL = 1.
  81.  
  82.  "EchoMail added to conference(s) ..."   -  This means that the program
  83.                                             determined that the last user
  84.                                             did enter a message into at least
  85.                                             one echomail conference.  This
  86.                                             message appears if the /ANY switch
  87.                                             is omitted and the user enters a
  88.                                             message into echomail.  Program
  89.                                             will exit with ERRORLEVEL = 1.
  90.  
  91.  "NetMail added to conference(s) ..."    -  This means that the program
  92.                                             determined that the last user
  93.                                             did enter a message into the
  94.                                             NETMAIL conference.  This message
  95.                                             appears if the /ANY switch is
  96.                                             omitted and the user enters a
  97.                                             message into netmail.  Program
  98.                                             will exit with ERRORLEVEL = 1.
  99.  
  100.  "Mail Door Was Executed ..."            -  This means that the program
  101.                                             determined that the last user
  102.                                             called upon the TomCat Mail Door.
  103.                                             Even if the user did not upload a
  104.                                             reply, the program will still exit
  105.                                             with ERRORLEVEL = 1, because TomCat
  106.                                             does not indicate what happened
  107.                                             inside the door within the activity
  108.                                             log entry.
  109.  
  110.  "Event Log Activity Was Ignored ..."    -  This means that while processing
  111.                                             the activity log, the program found
  112.                                             that a Wildcat soft event occurred
  113.                                             between the time the user logged
  114.                                             off, and the time the CheckMail
  115.                                             utility was run.  The program will
  116.                                             ignore the event entry, and scan
  117.                                             backward until it finds the last
  118.                                             user login entry.  Program will
  119.                                             continue to execute normally.
  120.  
  121. The current version of CheckMail is version 1.03.  This newest release of
  122. CheckMail will detect when the TomCat Mail Door was called by your user.
  123. Note that the program will set the ERRORLEVEL to 1 WHENEVER TomCat is
  124. called upon by the user, regardless of whether the user uploaded replies
  125. or downloaded messages.  This is because TomCat does not log what the
  126. user did while in the mail door.
  127.  
  128. The program also will now by default only check conferences described as
  129. "echomail" or "netmail".  This can be turned off with the /ANY switch.  To
  130. determine which conferences are echomail or netmail, the program will
  131. examine the AREAS.BBS file and WM.CFG file used by the Online Computer
  132. Resources WILDMAIL 2.0 mail tossing program.  If you are using other
  133. networks other than Fido, or using a non-standard echomail system, then
  134. using the /ANY switch will make the program watch for any type of message
  135. and act accordingly.
  136.  
  137. *** NOTE:  The AREAS.BBS file and WM.CFG file MUST reside in the
  138.            same directory as the CHKMAIL.EXE file !
  139.  
  140. Also, in earlier releases of the program, if Wildcat executed an event such
  141. as the No Node Page event, which was executed as a "soft" event after a user
  142. logged off, the program would see the entry from the event as a separate
  143. log on.  This has been fixed in version 1.02 by causing the program to
  144. ignore the event entry in the activity log.
  145.  
  146.  
  147. ╔═════════════════════════════════════════════════════════════════════════════╗
  148. ║                        * * *  Modification List * * *                       ║
  149. ╟─────────────────────────────────────────────────────────────────────────────╢
  150. ║                                                                             ║
  151. ║   Version 1.00 - Introduced CheckMail For Wildcat 3.0.                      ║
  152. ║                                                                             ║
  153. ║   Version 1.01 - Provided Greatly Improved Speed for Mail Checking.         ║
  154. ║                                                                             ║
  155. ║   Version 1.02 - Provided Support For TomCat Mail Door, and for             ║
  156. ║                  ignoring Activity Log entries created by the               ║
  157. ║                  Wildcat Event Handler.                                     ║
  158. ║                                                                             ║
  159. ║   Version 1.03 - Provided the ability to only set the errorlevel for        ║
  160. ║                  echomail or netmail conferences, so that Wildmail does     ║
  161. ║                  not have to be run if the user enters a message into       ║
  162. ║                  a conference that is local to the BBS only.                ║
  163. ║                                                                             ║
  164. ╚═════════════════════════════════════════════════════════════════════════════╝
  165.  
  166.  
  167. ** END OF CHKMAIL.DOC **
  168.  
  169. ╔═════════════════════════════════════════════════════════════════════════════╗
  170. ║   This program is SHAREWARE. Please feel free to copy and distribute this   ║
  171. ║    but DO NOT modify it in any way.  Computer Discount Center, Ltd. will    ║
  172. ║      not be liable for any loss resulting from the use of this program.     ║
  173. ║                                                                             ║
  174. ║               ┌──────────────────────────────────────────────┐              ║
  175. ║               │   * * *  Registration is only $5.00  * * *   │              ║
  176. ║               │                                              │              ║
  177. ║               │     To register by phone, have your Visa     │              ║
  178. ║               │      MasterCard, or Discover card ready,     │              ║
  179. ║               │           and call (904) 823-9669.           │              ║
  180. ║               │                                              │              ║
  181. ║               │                    * OR *                    │              ║
  182. ║               │                                              │              ║
  183. ║               │        Please make checks payable to:        │              ║
  184. ║               │        Computer Discount Center, Ltd.        │              ║
  185. ║               │          and mail to address below:          │              ║
  186. ║               └──────────────────────────────────────────────┘              ║
  187. ║                Please leave your comments and suggestions to:               ║
  188. ║                                                                             ║
  189. ║                        Computer Discount Center, Ltd.                       ║
  190. ║                       1260-B North Ponce de Leon Blvd.                      ║
  191. ║                           St. Augustine, FL  32084                          ║
  192. ║                                (904) 823-9669                               ║
  193. ║                                                                             ║
  194. ║         or you may leave Netmail to 1:3620/13, attention Jerry Ray.         ║
  195. ║               Thank you for supporting the shareware concept.               ║
  196. ╚═════════════════════════════════════════════════════════════════════════════╝
  197.  
  198.           WildMail and WM is a trademark of Online Computer Resources.
  199.                    WildCat is a trademark of Mustang Software.
  200.